window: add note about window references
authorDavid Schleef <ds@schleef.org>
Sat, 10 Dec 2011 22:29:16 +0000 (14:29 -0800)
committerMatthias Clasen <mclasen@redhat.com>
Sat, 25 Jan 2014 04:53:13 +0000 (23:53 -0500)
https://bugzilla.gnome.org/show_bug.cgi?id=665928

gtk/gtkwindow.c

index 3d9e858a96dd85f120bf400debdde0e4b8f572bd..303d319724ea42ef38609109504314d43133a726 100644 (file)
@@ -1837,6 +1837,14 @@ gtk_window_buildable_custom_finished (GtkBuildable  *buildable,
  *
  * If you simply want an undecorated window (no window borders), use
  * gtk_window_set_decorated(), don't use #GTK_WINDOW_POPUP.
+ *
+ * All top-level windows created by gtk_window_new() are stored in
+ * an internal top-level window list.  This list can be obtained from
+ * gtk_window_list_toplevels().  Due to Gtk+ keeping a reference to
+ * the window internally, gtk_window_new() does not return a reference
+ * to the caller.
+ *
+ * To delete a #GtkWindow, call gtk_window_destroy().
  * 
  * Return value: a new #GtkWindow.
  **/